home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / formats / hdf / hdfs.ch2 < prev    next >
Text File  |  1980-02-06  |  4KB  |  175 lines
  1.  
  2.  
  3. Chapter 2    The NCSA HDF General Purpose Interface
  4.  
  5.  
  6.  
  7. Chapter Overview
  8. Introduction
  9. Opening and Closing Files
  10. Finding Tags, Refs, and Element Lengths
  11. Reading and Writing Entire Data Elements
  12. Reading and Writing Part of a Data Element
  13. Manipulating Data Descriptors (DDs)
  14.  
  15. Chapter Overview
  16.  
  17. This chapter contains a list of the routines that make up the low 
  18. level interface. The interface is described in detail in the HDF 
  19. manual.
  20.  
  21.  
  22. Introduction
  23.  
  24. NCSA supports interfaces for HDF users both high level 
  25. interfaces to support certain application areas, such as image 
  26. processing, and a low level general purpose interface for 
  27. performing basic operations on HDF files.
  28.  
  29. Since the NCSA user community programs primarily in C and 
  30. Fortran, all of the HDF interfaces developed at NCSA are callable 
  31. from both C and Fortran programs. Accordingly, all of the 
  32. functions have both a C and a Fortran definition. For details, see 
  33. the NCSA HDF manual.
  34.  
  35. The routines in the general purpose interface enable you to build 
  36. and manipulate HDF files of any type, including those of your own 
  37. invention. All HDF applications developed at NCSA use these 
  38. routines as their basic building blocks. 
  39.  
  40.  
  41. Opening and Closing Files
  42.  
  43. The following calls are used to open and close HDF files.
  44.  
  45. DFopen    provides an access path to an HDF file. It also reads 
  46. into primary memory all of the DD blocks in the file. 
  47. In the current implementation, only one file can be 
  48. open at a time.
  49.  
  50. DFclose    updates the DD blocks, then closes the access path to 
  51. the file.
  52.  
  53.  
  54. Finding Tags, Refs, and Element Lengths
  55.  
  56. These routines make it possible to locate elements without 
  57. previously knowing their tags and reference numbers.
  58.  
  59. DFsetfind    initializes searches for elements using tags and 
  60. reference numbers. DFsetfind is closely tied to the 
  61. operation of DFfind.
  62.  
  63. DFfind    gets the results from searches of tags and reference 
  64. numbers.
  65.  
  66. Reading and Writing Entire Data Elements
  67.  
  68. There are two sets of routines for reading and writing data 
  69. elements. The first set of routines described here is used to store 
  70. and retrieve entire data elements. A second set of routines, 
  71. described in the next section, may be used if you wish to access only 
  72. part of a data element at a time.
  73.  
  74. DFputelement    adds or replaces elements in a file.
  75.  
  76. DFgetelement    obtains the data referred to by the tag/ref 
  77. combination that is passed to it.
  78.  
  79.  
  80. Reading and Writing Part of a Data Element
  81.  
  82. The second set of routines for reading and writing data elements 
  83. makes it possible to read or write all or part of a data element, in 
  84. contrast to the routines described above which can only read or 
  85. write an entire element.
  86.  
  87. DFaccess    initiates a read or write on the data element with the 
  88. specified tag/ref combination.
  89.  
  90. DFread    reads a portion of a data element. It starts at the last 
  91. position left by a DFaccess, DFread, or DFseek 
  92. command and reads any data that remains in the 
  93. element up to a specified number of bytes.
  94.  
  95. DFwrite    appends data to a data element. It starts at the last 
  96. position left by a DFaccess or DFwrite command, 
  97. writes up to a specified number of bytes, then leaves 
  98. the write pointer at the end of the element.
  99.  
  100. DFseek    sets the read pointer to an offset within a data 
  101. element. The next time DFread is called, the read 
  102. occurs from the new position.
  103.  
  104.  
  105. Manipulating Data Descriptors (DDs)
  106.  
  107. These routines perform operations on DDs without doing anything 
  108. with the data to which the DDs refer.
  109.  
  110. DFupdate    writes out the DD blocks necessary to update the file. 
  111. All data elements that have been written or partially 
  112. written to the file are given valid DDs.
  113.  
  114. DFdup    is used to generate new references to data that is 
  115. already referenced from somewhere else.
  116.  
  117. DFdel    deletes a tag/ref from the list of DDs.
  118. 2.1    NCSA HDF 
  119. Specific
  120. ations
  121.  
  122. The NCSA 
  123. HDF 
  124. Gene
  125. ral 
  126. Purpose 
  127. Inter
  128. face    2.1
  129.  
  130. Nationa
  131. l 
  132. Cente
  133. r for 
  134. Supercomp
  135. uting 
  136. Applicat
  137. ions
  138.  
  139. March 
  140. 1989
  141.  
  142.                                                                 
  143.  
  144.  
  145.  
  146. 2.1    NCSA HDF 
  147. Specific
  148. ations
  149.  
  150. The NCSA 
  151. HDF 
  152. Gene
  153. ral 
  154. Purpose 
  155. Inter
  156. face    2.1
  157.  
  158. Nationa
  159. l 
  160. Cente
  161. r for 
  162. Supercomp
  163. uting 
  164. Applicat
  165. ions
  166.  
  167. March 
  168. 1989
  169.  
  170.                                                                 
  171.  
  172.  
  173.  
  174.  
  175.